Remove "include_type_name" from most places in docs #37556
Conversation
cbuescher
added
>docs
|
Pinging @elastic/es-search |
| @@ -11,7 +11,7 @@ For example, let's say we have an index of questions and answers. The answer typ | |||
|
|
|||
| [source,js] | |||
| -------------------------------------------------- | |||
| PUT child_example?include_type_name=true | |||
| PUT child_example | |||
| { | |||
| "mappings": { | |||
| "_doc": { | |||
There was a problem hiding this comment.
To update this example, we'll also need to remove the type name _doc from the mappings definition. In my original PR, I wasn't able to figure out a good way to do this programmatically.
There was a problem hiding this comment.
I see, I was under the false impression that the parameter was added solely to prevent failing docs-tests.
In that case probably large parts of this PR are void, but I think at least a huge chunk of the cases e.g. under "analysis" don't touch mappings at all, so I'll see if I can skim these quickly and maybe just restrict the PR to those simple cases.
|
@cbuescher thanks a lot for looking into this. I actually don't think most uses of |
|
@jtibshirani sorry, I see know why this PR went a bit too far and there is actually quiet a bit of manual work. I took a step back and tried to at least eliminate the use of the "include_type_name" parameter where it seems quite clear the request doesn't touch mappings. I opened #37568 for that which leaves about 159 locations untouched, but still manages to remove about 140 instances. Let me know what you think. I will close this PR in favour of #37568 |
The "include_type_name" parameter was temporarily introduced in #37285 to facilitate
moving the default parameter setting to "false" in many places in the documentation
code snippets. Most of the places can simply be reverted without causing errors now
which this change does. The remaining nine files with approx. 37 cases where removing
the parameter causes an error will be adressed in a follow up.